/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.web.gwt.form.client.form.impl;

import java.util.ArrayList;
import java.util.List;

import com.genia.toolbox.web.gwt.basics.client.support.GwtObjectUtils;
import com.genia.toolbox.web.gwt.form.client.form.BasicForm;
import com.genia.toolbox.web.gwt.form.client.form.Form;

/**
 * Abstract class that define a basicForm.
 * 
 * @param <FORM>
 *          the type of subforms of this layout
 */
public abstract class AbstractBasicForm<FORM extends Form>
    extends AbstractForm
    implements BasicForm<FORM>
{
  /**
   * a list of Form.
   */
  private List<FORM> forms = new ArrayList<FORM>();



  /**
   * add a form to the list of Forms.
   * 
   * @param form
   *          is of type Form.
   */
  public void addForm(final FORM form)
  {
    forms.add(form);
  }



  /**
   * Indicates whether some other object is "equal to" this one.
   * 
   * @param obj
   *          the reference object with which to compare.
   * @return <code>true</code> if this object is the same as the obj argument;
   *         <code>false</code> otherwise.
   * @see java.lang.Object#equals(java.lang.Object)
   */
  @Override
  public boolean equals(final Object obj)
  {
    if (obj == this) {
      return true;
    }
    if (!super.equals(obj)) {
      return false;
    }

    if (obj instanceof AbstractBasicForm) {
      final BasicForm<?> oItem = (BasicForm<?>) obj;

      return GwtObjectUtils.nullSafeEquals(getForms(), oItem.getForms());
    }

    return false;

  }



  /**
   * returns the {@link List} of sub forms of this element.
   * 
   * @return the {@link List} of sub forms of this element
   */
  public List<FORM> getForms()
  {
    return forms;
  }



  /**
   * Returns a hash code value for the object. This method is supported for the
   * benefit of hashtables such as those provided by
   * <code>java.util.Hashtable</code>.
   * 
   * @return a hash code value for this object.
   * @see java.lang.Object#hashCode()
   */
  @Override
  public int hashCode()
  {
    return GwtObjectUtils.nullSafeHashCode(new Object[] { new Integer(super.hashCode()), getForms() });
  }



  /**
   * setter for the forms property.
   * 
   * @param forms
   *          the forms to set
   */
  public void setForms(final List<FORM> forms)
  {
    this.forms = forms;
  }

}
